<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>S110_nRF51822/Include/ble/ble_services/ble_sps.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="alias.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="alias.js"></script>

<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>


<script type="text/javascript">
  jQuery(document).ready(function () {
    if(gref){ // Number all _img and _table classes
      gref();
    }
  });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->

<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">nRF51822 BLE SDK
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('ble__sps_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">S110_nRF51822/Include/ble/ble_services/ble_sps.h</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.</span>
<a name="l00002"></a>00002 <span class="comment"> *</span>
<a name="l00003"></a>00003 <span class="comment"> * The information contained herein is property of Nordic Semiconductor ASA.</span>
<a name="l00004"></a>00004 <span class="comment"> * Terms and conditions of usage are described in detail in NORDIC</span>
<a name="l00005"></a>00005 <span class="comment"> * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Licensees are granted free, non-transferable use of the information. NO</span>
<a name="l00008"></a>00008 <span class="comment"> * WARRANTY of ANY KIND is provided. This heading must NOT be removed from</span>
<a name="l00009"></a>00009 <span class="comment"> * the file.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * $LastChangedRevision$</span>
<a name="l00012"></a>00012 <span class="comment"> */</span>
<a name="l00013"></a>00013 
<a name="l00014"></a>00014 <span class="preprocessor">#ifndef BLE_SPS_H__</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span><span class="preprocessor">#define BLE_SPS_H__</span>
<a name="l00016"></a>00016 <span class="preprocessor"></span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;stdint.h&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;stdbool.h&gt;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &quot;ble.h&quot;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &quot;<a class="code" href="ble__srv__common_8h.html">ble_srv_common.h</a>&quot;</span>
<a name="l00021"></a>00021 
<a name="l00023"></a>00023 <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00024"></a>00024 {
<a name="l00025"></a>00025     BLE_SPS_EVT_NOTIFICATION_ENABLED,                           
<a name="l00026"></a>00026     BLE_SPS_EVT_NOTIFICATION_DISABLED,                          
<a name="l00027"></a>00027     BLE_SPS_EVT_SCAN_INTERVAL_WINDOW_UPDATED                    
<a name="l00028"></a>00028 } ble_sps_evt_type_t;
<a name="l00029"></a>00029 
<a name="l00031"></a>00031 <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00032"></a>00032 {
<a name="l00033"></a><a class="code" href="structscan__interval__window__t.html#aee6704e14e4d5c590990ef4b80857b94">00033</a>     uint16_t <a class="code" href="structscan__interval__window__t.html#aee6704e14e4d5c590990ef4b80857b94">scan_interval</a>;                                     
<a name="l00034"></a><a class="code" href="structscan__interval__window__t.html#a85da8bab044d1c19454c091830144e06">00034</a>     uint16_t <a class="code" href="structscan__interval__window__t.html#a85da8bab044d1c19454c091830144e06">scan_window</a>;                                       
<a name="l00035"></a>00035 } <a class="code" href="structscan__interval__window__t.html" title="Scan Interval Window type.">scan_interval_window_t</a>;
<a name="l00036"></a>00036 
<a name="l00038"></a>00038 <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040     ble_sps_evt_type_t evt_type;
<a name="l00041"></a>00041     <span class="keyword">union</span>
<a name="l00042"></a>00042     {
<a name="l00043"></a><a class="code" href="structble__sps__evt__t.html#a4e34f43a855ddfa3087c3f6cb2c86ec7">00043</a>         <a class="code" href="structscan__interval__window__t.html" title="Scan Interval Window type.">scan_interval_window_t</a> <a class="code" href="structble__sps__evt__t.html#a4e34f43a855ddfa3087c3f6cb2c86ec7">scan_interval_window</a>;            
<a name="l00044"></a>00044     } params;
<a name="l00045"></a>00045 } <a class="code" href="structble__sps__evt__t.html" title="Scan Parameters Service event.">ble_sps_evt_t</a>;
<a name="l00046"></a>00046 
<a name="l00047"></a>00047 <span class="comment">// Forward declaration of the ble_sps_t type for the sake of defining the ble_sps_evt_handler_t type.</span>
<a name="l00048"></a>00048 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structble__sps__s.html" title="Scan Parameters Service structure. This contains information used by the service code to identify an ...">ble_sps_s</a> <a class="code" href="structble__sps__s.html" title="Scan Parameters Service structure. This contains information used by the service code to identify an ...">ble_sps_t</a>;
<a name="l00049"></a>00049 
<a name="l00051"></a>00051 <span class="keyword">typedef</span> void (*ble_sps_evt_handler_t) (<a class="code" href="structble__sps__s.html" title="Scan Parameters Service structure. This contains information used by the service code to identify an ...">ble_sps_t</a>* p_sps, <a class="code" href="structble__sps__evt__t.html" title="Scan Parameters Service event.">ble_sps_evt_t</a> *p_evt);
<a name="l00052"></a>00052 
<a name="l00054"></a>00054 <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00055"></a>00055 {
<a name="l00056"></a><a class="code" href="structble__sps__init__t.html#a7aeefe6c6dc3a2ee141fe1b44b7f27a8">00056</a>     ble_sps_evt_handler_t        <a class="code" href="structble__sps__init__t.html#a7aeefe6c6dc3a2ee141fe1b44b7f27a8">evt_handler</a>;                   
<a name="l00057"></a><a class="code" href="structble__sps__init__t.html#a827e12fe99e416080185c5b5dae42b5f">00057</a>     <span class="keywordtype">bool</span>                         <a class="code" href="structble__sps__init__t.html#a827e12fe99e416080185c5b5dae42b5f">is_scan_refresh_supported</a>;     
<a name="l00058"></a><a class="code" href="structble__sps__init__t.html#a0d2bc339c401d1277710916806a9e6ff">00058</a>     <a class="code" href="structscan__interval__window__t.html" title="Scan Interval Window type.">scan_interval_window_t</a> *     <a class="code" href="structble__sps__init__t.html#a0d2bc339c401d1277710916806a9e6ff">p_initial_scan_int_window</a>;     
<a name="l00059"></a><a class="code" href="structble__sps__init__t.html#ad67bc2e126b7cda05a2c17e8cd436322">00059</a>     uint8_t                      <a class="code" href="structble__sps__init__t.html#ad67bc2e126b7cda05a2c17e8cd436322">initial_scan_refresh</a>;          
<a name="l00060"></a><a class="code" href="structble__sps__init__t.html#aa491122e9bf5232c86f66e8d647a5c77">00060</a>     <a class="code" href="structble__srv__cccd__security__mode__t.html" title="Security settings structure.">ble_srv_cccd_security_mode_t</a> <a class="code" href="structble__sps__init__t.html#aa491122e9bf5232c86f66e8d647a5c77">scan_refresh_attr_md</a>;          
<a name="l00061"></a><a class="code" href="structble__sps__init__t.html#a91d9613a56fb283c2e7d1e6647da3f7c">00061</a>     <a class="code" href="structble__srv__security__mode__t.html" title="Security settings structure.">ble_srv_security_mode_t</a>      <a class="code" href="structble__sps__init__t.html#a91d9613a56fb283c2e7d1e6647da3f7c">scan_interval_window_attr_md</a>;  
<a name="l00062"></a>00062 } <a class="code" href="structble__sps__init__t.html" title="Scan Parameters Service init structure. This contains all options and data needed for initialization ...">ble_sps_init_t</a>;
<a name="l00063"></a>00063 
<a name="l00065"></a>00065 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structble__sps__s.html" title="Scan Parameters Service structure. This contains information used by the service code to identify an ...">ble_sps_s</a>
<a name="l00066"></a>00066 {
<a name="l00067"></a><a class="code" href="structble__sps__s.html#a7aeefe6c6dc3a2ee141fe1b44b7f27a8">00067</a>     ble_sps_evt_handler_t        <a class="code" href="structble__sps__s.html#a7aeefe6c6dc3a2ee141fe1b44b7f27a8">evt_handler</a>;                   
<a name="l00068"></a><a class="code" href="structble__sps__s.html#a363e00d9262febd8d752ed2f933be1e4">00068</a>     uint16_t                     <a class="code" href="structble__sps__s.html#a363e00d9262febd8d752ed2f933be1e4">service_handle</a>;                
<a name="l00069"></a><a class="code" href="structble__sps__s.html#a4202fb05e358ba2c9544df9102096957">00069</a>     <a class="code" href="structble__gatts__char__handles__t.html" title="GATT Characteristic Definition Handles.">ble_gatts_char_handles_t</a>     <a class="code" href="structble__sps__s.html#a4202fb05e358ba2c9544df9102096957">scan_interval_window_handles</a>;  
<a name="l00070"></a><a class="code" href="structble__sps__s.html#a5b5e3721b745351bf69e477a182d7d0c">00070</a>     <a class="code" href="structble__gatts__char__handles__t.html" title="GATT Characteristic Definition Handles.">ble_gatts_char_handles_t</a>     <a class="code" href="structble__sps__s.html#a5b5e3721b745351bf69e477a182d7d0c">scan_refresh_handles</a>;          
<a name="l00071"></a><a class="code" href="structble__sps__s.html#a0d5ffe38d68e48d81e61fc6a4999ae68">00071</a>     uint16_t                     <a class="code" href="structble__sps__s.html#a0d5ffe38d68e48d81e61fc6a4999ae68">conn_handle</a>;                   
<a name="l00072"></a><a class="code" href="structble__sps__s.html#a1787c2620c0cdedfa3610506261ca472">00072</a>     <span class="keywordtype">bool</span>                         <a class="code" href="structble__sps__s.html#a1787c2620c0cdedfa3610506261ca472">is_notification_enabled</a>;         <span class="comment">//TODO: Align battery service code</span>
<a name="l00073"></a>00073 } <a class="code" href="structble__sps__s.html" title="Scan Parameters Service structure. This contains information used by the service code to identify an ...">ble_sps_t</a>;
<a name="l00074"></a>00074 
<a name="l00075"></a>00075 
<a name="l00086"></a>00086 uint32_t ble_sps_init(<a class="code" href="structble__sps__s.html" title="Scan Parameters Service structure. This contains information used by the service code to identify an ...">ble_sps_t</a> * p_sps, <span class="keyword">const</span> <a class="code" href="structble__sps__init__t.html" title="Scan Parameters Service init structure. This contains all options and data needed for initialization ...">ble_sps_init_t</a> * p_sps_init);
<a name="l00087"></a>00087 
<a name="l00095"></a>00095 <span class="keywordtype">void</span> ble_sps_on_ble_evt(<a class="code" href="structble__sps__s.html" title="Scan Parameters Service structure. This contains information used by the service code to identify an ...">ble_sps_t</a> * p_sps, <a class="code" href="structble__evt__t.html" title="Common BLE Event type, wrapping the module specific event reports.">ble_evt_t</a> * p_ble_evt);
<a name="l00096"></a>00096 
<a name="l00106"></a>00106 uint32_t ble_sps_scan_refresh_send(<a class="code" href="structble__sps__s.html" title="Scan Parameters Service structure. This contains information used by the service code to identify an ...">ble_sps_t</a> * p_sps, uint8_t scan_refresh);
<a name="l00107"></a>00107 
<a name="l00108"></a>00108 <span class="preprocessor">#endif // BLE_SPS_H__</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>ble_sps.h</b>      </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


    <li class="footer">
      Copyright &copy 2006-2011 <a href="http://www.nordicsemi.no" style="text-decoration:none">Nordic Semiconductor</a>.
      All Rights Reserved.
      <a href="disclaimer.html">Disclaimer</a>
    </li>
   </ul>
 </div>


</body>
</html>
